Configuring Export: PGAS Data XML Commands

If installed, use the Export: PGAS Data XML command to export raw data records for a defined time range from FMS to a specified directory location in a PGAS XML format (conforms to PGAS version 16). Data that is not from a raw data source, e.g. has been imported into FMS via .csv files (categorized as a "User file" source), is not included in the export.

When the Export: PGAS Data XML command is executed, data is resolved for each eligible device via hard coded data item mappings in the application. To achieve this, a command definition file (CDF) must also be present, so that the FMS service can export the raw data records specified. The file is not editable at this time.

See FMS Commands and PGAS Data XML for more information about using this command via CygNet Explorer (MSS).

See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands.

See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.

See CxFms for more information about scripting commands.

Command Requirements

To enable the command to export raw data to PGAS XML files, and see the command listed in command management options, the following elements must be present.

• PGAS Export CDF - CygNet Measurement provides a command definition file (CDF) that must be made available on your system to enable the raw data to be exported from FMS to PGAS XML files. The data item mappings necessary to execute the export command to the corresponding PGAS file format are hard-coded in the system, and are not editable at this time. See Utilizing the Command Definition File for more information about data item mappings.

  The specific CDF file (ExportPgasXml.cdf) must be included in the CygNet\Services\FMS\CommandDefs folder on your host server, as follows.

  1. On your host server, in the CygNet\Services\FMS\CommandDefs\ExportSamples folder, find the SampleExportPgasXml.cdf (command definition) file and copy it up one level to the CygNet\Services\FMS\CommandDefs folder. Important: Do not alter or add to the sample file contents.
  2. Remove the word "Sample" from the file name (for the new copy of the file). The file must be named ExportPgasXml.cdf so that the file will be recognized by the FMS service.
  3. Restart the FMS service.

Configuring an Export: PGAS Data XML Command

If desired (optional), familiarize yourself with item mappings used by the system to export the raw data. These items cannot currently be viewed in the file, and the file content must not be altered.

Use the following procedure to configure PGAS Data XML exports.

To Configure an Export: PGAS Data XML Command

1. Open the Command menu in FMS Explorer.
2. Click Manage to access the FMS Command Definitions dialog box and then click Add to access the Create New FMS Command Definition dialog box.

   

3. Define the command definition properties.

1. Type a Name for the command into the text box. Maximum character count is 50.
2. Select the Command type from the drop-down menu.
3. Select a processing Priority from the drop-down menu.
4. Select a Logging level from the drop-down menu.
5. Click to select/clear the check box to Prompt when command runs.

5. Define the command parameters. The parameters for the Export: PGAS Data XML command are described in the Command parameters box, which includes the Description, a Required indicator, and a configurable Value field. Set the value for each required and each desired optional parameter, as indicated in its Value field.

6. Click Create New. The new command will appear in the list of FMS Command Definitions.

Command Definition Properties

The following command definition properties apply to Export: PGAS Data XML commands.

Command Parameters

The following command parameters apply to Export: PGAS Data XML commands when creating or editing commands via FMS Explorer.

Editing or Deleting an Export: PGAS Data XML Command

See Managing Node Commands for information about editing or deleting this command.

Running an Export: PGAS Data XML Command

See Running Node Commands for information about running this command.

Using the Command Definition File

When the command is run, raw data is exported to an XML file format consumable by PGAS. CygNet Measurement uses an FMS-to-PGAS internal mapping to produce the XML file. Data is exported as follows.

• If using a date-based export file name format and the selected file name already exists in the specified directory (as a valid PGAS XML file), any new data exported by the command will be exported to a new uniquely named file. The new file name is created by using the existing file name specified and appending a sequential two-digit index number to it, up to a maximum index of 99, after which point the export will no longer succeed.
• If using the Node name export file name format and the selected file name already exists in the specified directory, the export will fail.

Use the following procedure to make the command definition file (CDF) available to the FMS service, before executing the Export: PGAS Data XML command.

1. On your host server, in the CygNet\Services\FMS\CommandDefs\ExportSamples folder, find the SampleExportPgasXml.cdf (command definition) file and copy it up one level to the CygNet\Services\FMS\CommandDefs folder. Remove the word "Sample" from the file name of the new copy of the file, so that the file will be recognized by the FMS service. The file content must remain as-is; do not edit or add to the file.
2. Save the ExportPgasXml.cdf file.
3. Restart the FMS service.

Mapping of FMS Data Items to PGAS Attributes

CygNet Measurement automatically maps FMS data items to their related Alarm, Characteristics, Event, and Volume PGAS XML attributes for export. To identify equivalent data items for informational purposes, the following tables indicate item mappings used.

PGAS Alarms Attributes

PGAS Characteristics Attributes

PGAS Event Attributes

PGAS Event Tag Names

PGAS Volume Attributes

Items listed may be applicable for volume (V), quality (Q), or either (V, Q).